Clarify wrap_file lifecycle docs#3461
Closed
ishaanlabs-gg wants to merge 1 commit into
Closed
Conversation
Contributor
|
Sorry but making Claude write docs adds zero value -- people could just ask it. Anyways, tests should be added to make sure we aren't lying in the docs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3379.
This clarifies the asynchronous file object notes for
trio.wrap_file():aclose()on the async wrapper closes the wrapped synchronous file object.close()shortcut.I also added a
3379.doc.rstnewsfragment.Validation:
PATH=/Volumes/STOREJET/2/Dependencies/trio/docs-venv-313/bin:$PATH /Volumes/STOREJET/2/Dependencies/trio/docs-venv-313/bin/sphinx-build -b html -D 'exclude_patterns=._*' source build/htmlNotes:
docs-requirements.txtinto an external SSD venv using Python 3.13.immutables==0.21wheel, before Sphinx ran. Python 3.13 installed the pinned docs requirements cleanly.exclude_patterns=._*override is only for this local external drive, which creates AppleDouble._*metadata files that Sphinx otherwise treats as source files.